<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: ChannelState Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00044.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ChannelState Class Reference<div class="ingroups"><a class="el" href="a00512.html">decider - decider modules</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ChannelState" -->
<p>Provides information about the current state of the channel:  
 <a href="a00044.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00289_source.html">ChannelState.h</a>&gt;</code></p>

<p><a href="a00635.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a60196f82a7cf53dde36d88843343a6db">ChannelState</a> (bool isIdle=false, double <a class="el" href="a00044.html#abb965a7dd22a6000b4a1dc68e55152f7">rssi</a>=0.0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and initializes a new <a class="el" href="a00044.html" title="Provides information about the current state of the channel:">ChannelState</a> with the passed state.  <a href="#a60196f82a7cf53dde36d88843343a6db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab09e4515d5428b1287a62ec1bd1b01fe"></a><!-- doxytag: member="ChannelState::isIdle" ref="ab09e4515d5428b1287a62ec1bd1b01fe" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ab09e4515d5428b1287a62ec1bd1b01fe">isIdle</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the channel is considered idle, meaning depends on the used decider. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74ccec73c5ab45677575e568d3a455fa"></a><!-- doxytag: member="ChannelState::getRSSI" ref="a74ccec73c5ab45677575e568d3a455fa" args="() const " -->
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a74ccec73c5ab45677575e568d3a455fa">getRSSI</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current RSSI value of the channel. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#aa7125a711299c62119c5fe5bc3f43f1f">info</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Output for this <a class="el" href="a00044.html" title="Provides information about the current state of the channel:">ChannelState</a>.  <a href="#aa7125a711299c62119c5fe5bc3f43f1f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ade0df6803fb49731266569e7c94df2"></a><!-- doxytag: member="ChannelState::idle" ref="a6ade0df6803fb49731266569e7c94df2" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a6ade0df6803fb49731266569e7c94df2">idle</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">defines if the channel is currently idle <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb965a7dd22a6000b4a1dc68e55152f7"></a><!-- doxytag: member="ChannelState::rssi" ref="abb965a7dd22a6000b4a1dc68e55152f7" args="" -->
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#abb965a7dd22a6000b4a1dc68e55152f7">rssi</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the current RSSI value of the channel <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides information about the current state of the channel: </p>
<p>idle/busy - is the physical currently receiving something? RSSI - the currently received signal strength indicator. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a60196f82a7cf53dde36d88843343a6db"></a><!-- doxytag: member="ChannelState::ChannelState" ref="a60196f82a7cf53dde36d88843343a6db" args="(bool isIdle=false, double rssi=0.0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ChannelState::ChannelState </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isIdle</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>rssi</em> = <code>0.0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates and initializes a new <a class="el" href="a00044.html" title="Provides information about the current state of the channel:">ChannelState</a> with the passed state. </p>
<p>isIdle - defines if the channel is currently idle rssi - the current RSSI value of the channel </p>
<div class="fragment"><pre class="fragment">                                                       :
    <a class="code" href="a00044.html#a6ade0df6803fb49731266569e7c94df2" title="defines if the channel is currently idle">idle</a>(<a class="code" href="a00044.html#ab09e4515d5428b1287a62ec1bd1b01fe" title="Returns true if the channel is considered idle, meaning depends on the used decider.">isIdle</a>), <a class="code" href="a00044.html#abb965a7dd22a6000b4a1dc68e55152f7" title="the current RSSI value of the channel">rssi</a>(<a class="code" href="a00044.html#abb965a7dd22a6000b4a1dc68e55152f7" title="the current RSSI value of the channel">rssi</a>) {}
</pre></div>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa7125a711299c62119c5fe5bc3f43f1f"></a><!-- doxytag: member="ChannelState::info" ref="aa7125a711299c62119c5fe5bc3f43f1f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string ChannelState::info </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Output for this <a class="el" href="a00044.html" title="Provides information about the current state of the channel:">ChannelState</a>. </p>
<p>Of the form "[&lt;idle/busy&gt; with rssi of x]". </p>

<p>Referenced by <a class="el" href="a00128.html#ab3030c86acac78401f877a61cefcdad6">Mac80211::beginNewCycle()</a>.</p>
<div class="fragment"><pre class="fragment">                         {
    std::stringstream os;
    <span class="keywordflow">if</span> (<a class="code" href="a00044.html#a6ade0df6803fb49731266569e7c94df2" title="defines if the channel is currently idle">idle</a>) {
      os &lt;&lt; <span class="stringliteral">&quot;[idle with rssi of &quot;</span>;
    } <span class="keywordflow">else</span> {
      os &lt;&lt; <span class="stringliteral">&quot;[busy with rssi of &quot;</span>;
    }
    os &lt;&lt; <a class="code" href="a00044.html#abb965a7dd22a6000b4a1dc68e55152f7" title="the current RSSI value of the channel">rssi</a> &lt;&lt; <span class="stringliteral">&quot;]&quot;</span>;
    <span class="keywordflow">return</span> os.str();
  }
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/<a class="el" href="a00289_source.html">ChannelState.h</a></li>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/ChannelState.cc</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00044.html">ChannelState</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:31 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
